/*
 * This is Melet, a salary slip designer. Feed it with data regarding to salary payment, prepare it for print through the graphical presentation, and you have it done.
 * Copyright (C) 2014, AFDiaX
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * This program is based on UMLet, a Free UML Tool for Fast UML Diagrams.
 * To contact the authors of UMLet visit https://code.google.com/p/umlet/people/list
 * To contact the authors of Melet visit https://gna.org/users/gabocze
 */
package com.baselet.element.relation.helper;

import com.baselet.element.facet.Facet;

public enum LineDescriptionEnum {
	MESSAGE_START("m1", 1, true),
	MESSAGE_END("m2", 2, false),
	ROLE_START("r1", 3, true),
	ROLE_END("r2", 4, false),
	MESSAGE_MIDDLE("", 5, null) // Important: MESSAGE_MIDDLE must be the last because it can have multiple lines with indexes 5,6,7,8,... AND it matches as default if no other enum entry is valid
	;

	private final String key;
	private final int index;
	private final Boolean start;

	private LineDescriptionEnum(String key, int index, Boolean start) {
		this.key = key;
		this.index = index;
		this.start = start;
	}

	public int getIndex() {
		return index;
	}

	public String getKey() {
		return key;
	}

	public Boolean isStart() {
		return start;
	}

	public static LineDescriptionEnum forString(String line) {
		for (LineDescriptionEnum ld : LineDescriptionEnum.values()) {
			if (line.startsWith(ld.key + Facet.SEP)) {
				return ld;
			}
		}
		return LineDescriptionEnum.MESSAGE_MIDDLE;
	}

	public boolean isMessageStartOrEnd() {
		return this == LineDescriptionEnum.MESSAGE_START || this == LineDescriptionEnum.MESSAGE_END;
	}

	public boolean isRoleStartOrEnd() {
		return this == LineDescriptionEnum.ROLE_START || this == LineDescriptionEnum.ROLE_END;
	}

}